home *** CD-ROM | disk | FTP | other *** search
/ Whiteline: delta / whiteline CD Series - delta.iso / tex / style / misc / draft.sty < prev    next >
Internet Message Format  |  1995-11-25  |  10KB
  1. From root Wed Oct  6 12:04:53 1993
  2. Received: from niord.shsu.edu by numerik.FernUni-Hagen.de (AIX 3.2/UCB 5.64/4.04.CS)
  3.           id AA22414; Wed, 6 Oct 1993 11:58:46 +0100
  4. Message-Id: <9310061058.AA22414@numerik.FernUni-Hagen.de>
  5. Received: by SHSU.edu (MX V3.3 VAX) id 23265; Mon, 04 Oct 1993 04:09:28 CST
  6. Date: Mon, 04 Oct 1993 04:09:28 CST
  7. Sender: FILESERV-Mgr@SHSU.edu
  8. Errors-To: FILESERV-Mgr@SHSU.edu
  9. Warnings-To: <>
  10. From: FILESERV-Mgr@SHSU.edu
  11. Reply-To: FILESERV@SHSU.edu
  12. Subject: LTX3PUB.DRAFT_STY
  13. To: schrell@numerik.FernUni-Hagen.de
  14. Status: O
  15.  
  16. % NAME THIS FILE: draft.sty (or name it draft.doc and run it through
  17. % doc2sty) AND PUT IT IN YOUR MACROS OR TEXFORMATS DIRECTORY
  18. %
  19. % This is a first attempt at a draft option for the standard LaTeX styles.
  20. % It still has several problems, which are detailed below.
  21. % The draft option attempts to accomplish the following:
  22. %  Without requiring any changes to a LaTeX file (other than specifying
  23. %  the draft option :-) and without changing the formatting of the 
  24. %  ``real'' text , mark the spots where \label, \cite, \ref, \index,
  25. %  or \glossary commands occur in text, and print the command arguments
  26. %  in the margin.
  27. %
  28. % USAGE:
  29. % Specify draft as an optional argument to the documentstyle command
  30. % e.g., \documentstyle[11pt,draft]{book}
  31. %
  32. % JUSTIFICATION:
  33. % Why am I submitting this, even though it still has some problems?
  34. %
  35. %     1) Even in its present shape, I think it is fairly useful.
  36. %        I was going crazy before, trying to remember labels, keys,
  37. %        and so forth.  I am still going crazy, but now for different
  38. %        reasons.
  39. %     2) I'm just learning TeX, and don't expect to know enough to do this
  40. %        correctly for a while.  Hopefully, someone who knows TeX will
  41. %        agree this is a useful option, and will point out my mistakes.
  42. %        Since the changes to the standard LateX routines are fairly minor,
  43. %        and my mistakes are probably silly and quite obvious, this
  44. %        may be easy to do.
  45. %     3) I am interested in hearing ideas for other features for this
  46. %        option.  This option includes some of the ideas of Dr. Rouben 
  47. %        Rostamian (rostamia@umbc3.UMD.EDU) and I am interested in 
  48. %        hearing from others.
  49. %     4) Because of 2) and 3), I think we will end up with a better
  50. %        draft option if I post this in its present form and ask for
  51. %        help.
  52. %
  53. %     Please send bugs, fixes, and suggestions to:
  54. %      Joe Baker 
  55. %      6731 Boelter Hall   UCLA   L.A., CA 90024   (213) 825-7079, 825-2327
  56. %      INTERNET: jbaker@ee.ucla.edu 
  57. %      UUCP: {ucbvax, or other backbone}!ucla-cs!uclaee!jbaker
  58. %
  59. % FINALLY, THE DETAILS
  60. %
  61. % The option marks \label,\cite,\ref,\index, and \glossary commands in the
  62. % text with a scriptsize calligraphic letter in the interline space 
  63. % (L for label,
  64. % C for cite, R for ref, I for index and G for glossary.
  65. % The label, citation, is printed in the margin in scriptsize bold letters.  
  66. %   
  67. % For items which are input in horizontal mode, a \marginpar box holding 
  68. % the text is put in the right margin (if there are no free boxes left, 
  69. % the next option is used.) 
  70. % 
  71. % Items which are input in display math mode are shoved into the left
  72. % margin (parboxes are not used, so it is possible for one label to 
  73. % overwrite another, or for a label to run off the left edge of the page.)
  74. % 
  75. % Items which are input in non-display math mode and equation arrays
  76. % are giving me problems.  The left margin code works fine for equations
  77. % in the middle of text, but doesn't produce anything for equation arrays.
  78. % Unfortunately, I haven't found a way to distinguish between the two
  79. % cases.  For now, I simply raise the item and print it in small letters,
  80. % and hope to avoid hitting any superscripts.
  81. % 
  82. % Right now, a space or extra bit of glue is getting inserted where the 
  83. % item is, and thus the ``real'' text is not formatted quite the same in
  84. % draft mode.  On the tests I've run so far, there hasn't been enough
  85. % added space to actually change any of the linebreaks, so it doesn't
  86. % seem to be a serious problem.
  87. %
  88. %%%%%%%%%%%%%%%%%%%%%%%%%%%%% Okay, here it is %%%%%%%%%%%%%%%%%%%%%%%%%%
  89. % NOTE THIS:
  90. % force all marginpar items into the right margin, to leave the left 
  91. % margin for calls to marginalnote.
  92. \@mparswitchfalse
  93. %                     
  94. %
  95. % MARGINALNOTE
  96. %
  97. % The following is a slightly rewritten version of Knuth's marginalstar stuff
  98. % from the TeXBook, pg. 316.  It is used to put a marginalnote in the left
  99. % margin.  The note is just shoved out and made right justified w.r.t. the
  100. % left margin.  Two calls to marginalnote for the same line of text will
  101. % be written one over the other.  Long marginal notes will extend off the
  102. % page to the left.
  103. %
  104. \def\strutdepth{\dp\strutbox}%
  105. \def\marginalnote#1{\strut\vadjust{\kern-\strutdepth\specialnote{#1}}}%
  106. \def\specialnote#1{\vtop to \strutdepth{\baselineskip%
  107. \strutdepth\vss\llap{\hbox{\scriptsize \bf #1}}\null}}%
  108. %
  109. % NOTEMARK
  110. % This is used to put a little calligraphic letter in the text to mark
  111. % the spot where the item occurred.
  112. %
  113. \def\notemark#1{\rlap{%
  114. \specialnote{\raise8pt\hbox{$\scriptscriptstyle\cal#1$}}}}
  115. %
  116. % Since I haven't found one approach that works in all modes, I
  117. % have set up the makenote routine to use the following options
  118. % (draftimm, draftdmm, draftinm, drafthm) in inner math mode,
  119. % display math mode, inner non-math mode, and horizontal mode.
  120. % If you don't like one, redefine it before the begin{document}
  121. % line.
  122. \def\draftimm#1{\hbox{\bf \scriptsize #1}}
  123. \def\draftdmm#1{\marginalnote{#1}}
  124. \def\draftinm#1{\notemark{\bf \scriptsize #1}}
  125. \def\drafthm#1{\ifx\@freelist\@empty % if there are no boxes for a marginpar,
  126.                    \marginalnote{#1}  % use a marginalnote
  127.                  \else                  
  128.                    {\marginpar{\scriptsize \bf #1}}
  129.                  \fi}
  130.  
  131. %
  132. % MAKENOTE
  133. % this routine prints the command argument.  It tries to do the best it
  134. % can for the given mode.
  135. %
  136. %\def\makenote#1{            
  137. %                            
  138. %                            
  139. %    \ifmmode                % In math mode, we can't use 
  140. %                            % \marginpar, so we use marginalnote
  141. %                            % in display mode, and for now,
  142. %                            % just use bold print in inner mode
  143. %                            % marginalnote works okay in regular
  144. %                            % non-display math, but not in
  145. %                            % eqnarrays. By redefining draft...
  146. %                            % you can change this behavior.
  147. %        \ifinner
  148. %           \draftimm{#1} 
  149. %        \else
  150. %           \draftdmm{#1} 
  151. %        \fi
  152. %    \else
  153. %        \ifinner
  154. %           \draftinm{#1} 
  155. %         \else
  156. %           \drafthm{#1} 
  157. %         \fi
  158. %    \fi}
  159. \def\makenote#1{\ifmmode\ifinner\draftimm{#1}%
  160. \else\draftdmm{#1}\fi%
  161. \else\ifinner\draftinm{#1}%
  162. \else%
  163. \drafthm{#1}%
  164. \fi\fi}
  165. %
  166. % MODIFIED LATEX ROUTINES
  167. % We add the \notemark and \makenote routines to the \ref, \pageref,
  168. % \label, \index, \glossary, and \cite commands.
  169. %
  170. % REF
  171. %
  172. %  \ref{FOO} ==
  173. %    BEGIN
  174. %         make a reference mark in the text (calligraphic R)
  175. %      if \r@foo undefined  
  176. %        then  ?? 
  177. %              Warning: 'reference foo on page ... undefined'
  178. %        else  \@car \eval(\r@FOO)\@nil
  179. %      fi
  180. %        make a reference note (hopefully in the margin) listing the
  181. %        reference key
  182. %    END
  183. %
  184. \def\ref#1{\notemark{R}%
  185. \@ifundefined{r@#1}{{\bf ??}\@warning%
  186. {Reference `#1' on page \thepage \space %
  187. undefined}}{\edef\@tempa{\@nameuse{r@#1}}\expandafter%
  188. \@car\@tempa \@nil\null}\makenote{R:#1}}
  189. %
  190. % PAGEREF
  191. %
  192. %  \pageref{foo} = 
  193. %    BEGIN
  194. %      make a page reference mark in the text (calligraphic PR)
  195. %      if \r@foo undefined  
  196. %        then  ?? 
  197. %              Warning: 'reference foo on page ... undefined'
  198. %        else  \@cdr \eval(\r@FOO)\@nil
  199. %      fi
  200. %      make a reference note (hopefully in the margin) listing the
  201. %      page reference key
  202. %    END
  203. %
  204. \def\pageref#1{\notemark{PR}%
  205. \@ifundefined{r@#1}{{\bf ??}\@warning%
  206. {Reference `#1' on page \thepage \space %
  207. undefined}}{\edef\@tempa{\@nameuse{r@#1}}\expandafter%
  208. \@cdr\@tempa\@nil\null}\makenote{PR:#1}}%
  209. %
  210. % LABEL
  211. %
  212. % same story for the label routine
  213. \def\label#1%
  214. {\notemark{L}\makenote{L:#1}\@bsphack%
  215. \if@filesw{\let\thepage\relax%
  216. \xdef\@gtempa{\write\@auxout{\string%
  217. \newlabel{#1}{{\@currentlabel}{\thepage}}}}}\@gtempa%
  218. \if@nobreak\ifvmode\nobreak\fi\fi\fi\@esphack}
  219. %
  220. % INDEX 
  221. %  note that \@wrindex is normally used by both the index and the 
  222. %  glossary commands.  We will make a new version for the glossary
  223. %  command that differs only in putting out a G instead of an I.
  224. %
  225. %  \@wrindex{ITEM} ==
  226. %    BEGIN
  227. %     make an I mark in the text, and put the index item in the margin
  228. %        write of {\indexentry{ITEM}{page number}}
  229. %      \endgroup
  230. %      \@esphack
  231. %    END
  232. %
  233. \def\@wrindex#1#2{\notemark{I}\makenote{I:#2}%
  234. \let\thepage\relax%
  235. \xdef\@gtempa{\write#1{\string \indexentry{#2}{\thepage}}}\endgroup\@gtempa%
  236. \if@nobreak \ifvmode\nobreak\fi\fi\@esphack}%
  237. %
  238. % GLOSSARY
  239. % version for use by glossary commands
  240. %
  241. \def\@wrindexg#1#2{\notemark{G}\makenote{G:#2}%
  242. \let\thepage\relax%
  243. \xdef\@gtempa{\write#1{\string \indexentry{#2}{\thepage}}}\endgroup\@gtempa%
  244. \if@nobreak \ifvmode\nobreak\fi\fi\@esphack}%
  245. %
  246. % new version of the glossary stuff: just changed @wrindex to @wrindexg
  247. %
  248. \def\makeglossary{\if@filesw \newwrite\@glossaryfile
  249.   \immediate\openout\@glossaryfile=\jobname.glo
  250.   \def\glossary{\@bsphack\begingroup\@sanitize\@wrindexg\@glossaryfile}\typeout
  251.   {Writing glossary file \jobname.glo }\fi}
  252. %
  253. % CITE
  254. %
  255. % citex is used by the bibliography citation routines
  256. % the second argument is the citation key
  257. %
  258. \def\@citex[#1]#2{\notemark{C}\makenote{C:#2}%
  259. \if@filesw\immediate\write\@auxout{\string\citation{#2}}\fi%
  260. \def\@citea{}\@cite{\@for\@citeb:=#2\do%
  261. {\@citea\def\@citea{,}\@ifundefined%
  262. {b@\@citeb}{{\bf ?}\@warning%
  263. {Citation `\@citeb' on page \thepage \space undefined}}%
  264. \hbox{\csname b@\@citeb\endcsname}}}{#1}}
  265.  
  266.  
  267. ə